home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1994 November / macformat-018.iso / Utility Spectacular / Text / TextBreak Folder / TextBreak READ ME < prev   
Encoding:
Text File  |  1993-12-14  |  5.7 KB  |  126 lines  |  [TEXT/MSWD]
  1. ==================================
  2. “READ ME” for TextBreak, version 1.0
  3. ==================================
  4. Copyright © 1992 Robert Gibson. All rights reserved.
  5. January 1, 1992
  6. Font: Geneva 12
  7.  
  8. This document must go wherever TextBreak goes. Please do not distribute
  9. TextBreak without this documentation. Please do not modify this document.
  10.  
  11. INTRODUCTION
  12. =============
  13. This document contains information about TextBreak, a Drop Box by Robert
  14. Gibson. Information specific to TextBreak itself is given in “Using
  15. TextBreak”. Characteristics of Drop Boxes in general are discussed in the
  16. “Using Drop Boxes” section. Finally, information about the author is
  17. provided in the last section, “About the Author”.
  18.  
  19. USING TEXTBREAK
  20. ================
  21. These sections are fairly detailed descriptions of how and why you may
  22. use TextBreak. There are many ways to use, and purposes for, this program,
  23. that I don’t discuss.
  24.  
  25. Who Will Use TextBreak
  26. ---------------------
  27. •  TextBreak is an application written mainly for users who regularly
  28.     compose messages for on-line services and for other purposes which
  29.     require that text be organized such that each line is terminated by
  30.     a carriage return, and sometimes a linefeed. Normally on a Mac, it is
  31.     only paragraphs that are terminated by carriage returns. This poses
  32.     a potential source of agony, since it often requires that you physically
  33.     enter the carriage returns into your file, guessing at the best position
  34.     to insert one in each line. It is also a pain if you wish to add text to
  35.     a file that has already been organized into lines.
  36.  
  37. •  If you use TextBreak, please please please send me a note. I love to
  38.     hear from users of my software. My addresses (post and e-mail) are
  39.     given below in “About the Author”. 
  40.  
  41. What Does TextBreak Do?
  42. -----------------------
  43. •  TextBreak determines the best location to end each line in a text file,
  44.     based on criteria you have set up. It inserts the carriage returns (and
  45.     linefeeds, if they are turned on) in the proper locations. The actual file
  46.     is modified; a copy is not made.
  47.  
  48. Using TextBreak
  49. ---------------
  50. •  TextBreak can be used in two ways. You can double-click on the
  51.     application icon to open the program, and use the Open... menu item in
  52.     the File menu to select text files for modification. Note that only
  53.     TEXT files can be modified by TextBreak. You can also modify your
  54.     preferences from this menu. You could also drag sets of files, folders,
  55.     or disks into the application, “Drop Box-style”. TextBreak will scan
  56.     folders and disks provided, and will modify ALL text files in ALL of the
  57.     directories provided, no matter what their depth. The latter method
  58.     requires Apple Events, and thus System 7.0 or higher. Tabs and spaces
  59.     are treated as identical one-column white space characters by
  60.     TextBreak.
  61.  
  62. •  To cancel processing, just type a command-period. Cancelling in the
  63.     middle of a file causes that file to be left unchanged. However, files
  64.     already processed will remain modified.
  65.  
  66. •  TextBreak uses a temp file for processing. Make sure that there is
  67.     enough space to make a duplicate copy of the largest file you are
  68.     operating on, on the disk that the file is contained in. Also make sure
  69.     that the disk is not locked.
  70.  
  71. Preferences
  72. -----------
  73. •  The first time you try to modify a file using the program, the
  74.     preferences dialog will come up, just to make sure the correct
  75.     parameters have been set up. You can modify these if you wish. If
  76.     you don't want to see that window again, just say OK. You will have to
  77.     explicitly ask for for the Preferences window the next time you wish
  78.     to change anything.
  79.  
  80. •  To show the Preferences dialog in Drop Box mode, hold down the option
  81.     key while the program is launching.
  82.  
  83. •  The preferences are fairly self-explanatory. You can set the maximum
  84.     number of columns of a monospaced font (like Monaco or Courier) to
  85.     allow in your text files, toggle the insertion of a linefeed after each
  86.     carriage return, and define how hyphens are treated in a file.
  87.  
  88. •  When hyphens are turned on, TextBreak can insert a return after a
  89.     hyphen. Otherwise, hyphens are treated like any other non-white-space
  90.     character.
  91.  
  92. USING DROP BOXES
  93. =================
  94. Drop Boxes are applications which can take advantage of System 7’s Apple
  95. Events. To use them, just drag a file over the application icon just as you
  96. would drag a file over a folder to move it into that directory. The Drop
  97. Box is then opened and processing is done. The program then quits. You can
  98. also throw in whole directories and disks. You don’t have to throw in just
  99. one, either. Select a whole bunch of files, directories, or disks, or any
  100. combination of the three, and dump them in. The Drop Box will scan for
  101. files of the required type and modify them accordingly. All files in all
  102. directories within those dropped in will be modified.
  103.  
  104. You can also open the program by double-clicking and modify files from
  105. inside the program, or you can open the program manually and then throw
  106. files in. The program will not quit this time.
  107.  
  108. At least, that is how Rob•Drop Boxes work.
  109.  
  110. ABOUT THE AUTHOR
  111. ==================
  112. If you use this program, have any comments or suggestions, or ideas for
  113. other programs, please write me a note, e-mail or post.
  114.  
  115. Robert Gibson                           E-Mail:
  116. RR#1 Carrying Place                    CIS:          71261,2236
  117. Ontario, CANADA                          Internet:  71261.2236@compuserve.com
  118. KØK 1LØ
  119.  
  120. This program is not to be included in any software collections other than
  121. BBSs and on-line services (eg. CD ROMs, PD Disks, etc.) without prior
  122. written consent from the author. Any distribution MUST MUST MUST
  123. include this document, unmodified.
  124.  
  125. TextBreak copyright © 1992 Robert Gibson. All rights reserved.
  126.